home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / adopt26.zip / ADOPT.DOC < prev    next >
Text File  |  1992-05-28  |  13KB  |  299 lines
  1.  
  2.                             ADOPT - A - DOOR
  3.  
  4.                                   v2.6
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    ADOPT is a stand-alone program that can be executed after every Door program
  21.    completes and before it returns to your BBS.  It will display a message that 
  22.    encourages your callers to donate to the BBS by adopting a given door or
  23.    group of doors and having his/her name displayed every time the particular
  24.    door is executed. There are 2 options available with ADOPT: 
  25.  
  26.    OPTION 1, UNREGISTERED version, will display a hard-coded (non-changeable)
  27.    message describing the Adopt-A-Door concept to your callers. The REGISTERED
  28.    version will allow you to create your own message (15 lines, 62 characters 
  29.    per line).
  30.    
  31.    OPTION 2 will display the names of the callers (max of 8) that have 
  32.    contributed to the registration of that particular door. This file is an
  33.    ASCII file you create with the names of the callers (Max 30 char/name). The
  34.    name of the file is your choice, but the name must match with the name in 
  35.    the configuration file.
  36.  
  37.  
  38.    
  39.    NOTE: Runtime errors will be logged to a file called DFRAME.ERR which is
  40.          created in the directory you run the door from.
  41.  
  42.  
  43.  
  44.                               INSTALLATION
  45.                               ____________
  46.  
  47.  
  48.    Installation is fairly easy and straight-forward. The following steps and
  49.    examples should have you up and running in a very short period of time.
  50.    It is assumed that you are familiar with setting up DOORS on your system.
  51.    To this end, only examples of the configuration file and Door batch file
  52.    are described.
  53.  
  54.       1) Create a directory to hold all ADOPT files
  55.  
  56.       2) Unzip ADOPTxx.ZIP into the the above directory
  57.  
  58.          NOTE: BRUN45.EXE is not included but is required !!!
  59.                It is available on Sunrise-80 BBS!
  60.  
  61.       3) Create a configuration file, with a name of your choice, or
  62.          modify the supplied ADOPT.CFG file. A description follows:
  63.  
  64.             **                       Location of system files (see below)
  65.             SUNRISE-80 BBS           Your BBS Name
  66.             Al                       Sysop's First Name
  67.             Lawrence                 Sysop's Last Name
  68.  
  69. |-----------------------------------------------------------------------------|
  70. | READ!     1                        CommPort  \ These 2 lines are required   |
  71. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  72. |-----------------------------------------------------------------------------|
  73.  
  74.             00000000                 Registration Number
  75.             1                        1=Initial Message Display
  76.                                      2=Display Callers Names That Contributed
  77.        #    201                      ASCII Character Used TO Form Message Border
  78.        #    NONE                     File Name Containing Initial Display                                     
  79.        #    NONE                     File Name Containing Contributing Callers
  80.        #    30                       Number of SECONDS To Keep Msg On Screen
  81.        !    0                        Security level that will bypass the DOOR
  82.        !    0                        Security level that will bypass the DOOR
  83.        !    0                        Security level that will bypass the DOOR
  84.        !    0                        Security level that will bypass the DOOR
  85.        !    0                        Security level that will bypass the DOOR
  86.        !    0                        Security level that will bypass the DOOR
  87.        !    0                        Security level that will bypass the DOOR
  88.        !    0                        Security level that will bypass the DOOR
  89.        !    0                        Security level that will bypass the DOOR
  90.        !    0                        Security level that will bypass the DOOR
  91.  
  92.        ** = Replace with ONE of the following:
  93.             
  94. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  95. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  96. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  97.                                    (Note:DOOR.SYS must be in SAME directory)
  98. C:\BBS\DOOR.SYS                 <- For systems that support DOOR.SYS
  99. C:\BBS\DORINFOx.DEF             <- For QBBS/RBBS/RA. Replace x with Node #.
  100. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  101. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  102.  
  103.  
  104.         # = Requires registration to change to a different value
  105.         ! = If callers Security level matches any one of these levels,
  106.             the Adopt-A-Door program will NOT run!
  107.  
  108.  
  109.       4) Add ADOPT to the batch file that runs the Door, after whose completion
  110.          you want the ADOPT-A-DOOR message to be displayed. Using Yahtzee as
  111.          the example of the Door we want to run ADOPT after:
  112.  
  113.             ECHO off
  114.             cd\PCB\DOORS\YAHTZEE      Location of Yahtzee files
  115.             YAHTZEE YAHTZEE.CNF       EXE filename and CNF filename 
  116.             CD\PCB\DOORS\ADOPT        Location of ADOPT Files
  117.             ADOPT ADOPTYAH.CFG        EXE and UNIQUE .CNF Filename created
  118.                                       in #3 above.
  119.             CD\PCB
  120.             BOARD
  121.  
  122.  
  123.        5) When running in more than one node, be sure to supply a
  124.           different configuration name for each node (your choice of name).
  125.  
  126.  
  127.                         NON-STANDARD COM SUPPORT
  128.                         ________________________
  129.  
  130.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  131.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  132.       number after the configuration filename. Let's assume your Door is
  133.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  134.       passed to your Door would be:
  135.  
  136.                             FOOBAR FOOBAR.CFG /5
  137.  
  138.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  139.       normally used with COM1. No /x parameter is needed for the standard
  140.       IRQ's.
  141.  
  142.       As an alternative, you may use an environmental variable on the command
  143.       line. To use the variable (following the example above), place a 
  144.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  145.       different IRQ number for each node). The command line would now look 
  146.       like this: 
  147.  
  148.                           FOOBAR FOOBAR.CFG /%IRQ%
  149.       
  150.       This, in combination with the use of the environmental variables 
  151.       described in the MULTI-NODE SETUP section will allow you to use one 
  152.       batch file and one config file to run this door on all nodes.
  153.  
  154.  
  155.  
  156.  
  157.                            MULTI-NODE SETUP
  158.                            ________________
  159.  
  160.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  161.       ability to access a configuration file which will have its own system 
  162.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  163.       line. There are 2 ways to accomplish this:
  164.  
  165.       (1) Create a separate configuration file for each node. The only 
  166.           difference between each file would be the location of the system 
  167.           file for that particular node. For example, on my system there are 2
  168.           nodes and the first line of the config files would look like this:
  169.  
  170.                         NODE1:  H:\PCB1\DOOR.SYS
  171.                         NODE2:  H:\PCB2\DOOR.SYS
  172.  
  173.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  174.  
  175.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  176.           the following PCBoard environmental variables:
  177.  
  178.                  PCBDIR    (Directory containing the System file)
  179.                  PCBDRIVE  (Drive containing the System file)
  180.  
  181.           Thus, the first line of the SINGLE configuration file, for this Door
  182.           would look like this:
  183.  
  184.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  185.  
  186.       NOTE: This option, as described, assumes that you are running PCBoard 
  187.             14.5a software. The environmental variables are automatically 
  188.             created by the software for each node.
  189.  
  190.             HOWEVER, if you are running other BBS software you should be able
  191.             to set the variables EXACTLY as described below, for EACH node 
  192.             (more than likely in each batch file you use to bring up EACH node):
  193.  
  194.                             PCBDRIVE=C:
  195.                             ^^^^^^^^^
  196.                             PCBDIR=\NODE2
  197.                             ^^^^^^^^
  198.             
  199.             Info with a carat (^) under it, MUST be typed as is. The rest 
  200.             depends on your naming conventions. 
  201.  
  202.             This, in combination with the use of the optional environmental
  203.             variable described in the NON-STANDARD COM SUPPORT section, will
  204.             allow you to use one batch file and one config file to run this 
  205.             door on all nodes.
  206.  
  207.  
  208.  
  209.  
  210.                             ADOPT-A-DOOR  CONCEPT
  211.                             _____________________
  212.  
  213.     Having been a Sysop for a number of years, I have had my share of problems
  214.     and frustrations getting financial support for my board's upkeep. A fellow
  215.     Sysop left a message on my board, not long ago, about a concept that was
  216.     being used by several boards around the country.
  217.  
  218.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  219.     would be the same as sending in a donation, only this way it is earmarked
  220.     for registering a particular door. In a way, the user feels he/she is
  221.     "getting something in return". As a Door author I have decided to build
  222.     this concept into each of my Door programs. The concept replaces the
  223.     usual message "tell the Sysop to register this Door" we find in most
  224.     doors.
  225.  
  226.     At the same time I have developed this stand-alone program that will carry
  227.     this concept one step forward so as to be able to use it with any of your
  228.     door programs.
  229.  
  230.  
  231.  
  232.  
  233.                               LEGALITIES
  234.                               __________
  235.  
  236.  
  237.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  238.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  239.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  240.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  241.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  242.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  243.       OR BREACH OF ANY WARRANTY.
  244.  
  245.  
  246.  
  247.  
  248.  
  249.                              DISTRIBUTION
  250.                              ____________
  251.  
  252.    You may make this file available for downloading from your BBS or you may
  253.    upload it to any BBS of your choice, provided that you do not make any
  254.    changes to the contents of the archive (ZIP file). The archive and its
  255.    individual contents may not be used by any service that charges any money
  256.    whatsoever, without the written permission of the author.
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                              REGISTRATION
  263.                              ____________
  264.  
  265.    I am not a subscriber to the "Crippleware" concept, and this program
  266.    reflects that philosophy. This is a full-featured program, whose
  267.    functionality is not hampered in any way, whether you register it or not.
  268.    Registration and the subsequent insertion of the registration number into
  269.    your configuation file, allows for the changing of certain default values
  270.    in the configuration file.                                     
  271.  
  272.    To register your copy of ADOPT, please fill out the registration form
  273.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  274.    the name and address on the form. MUST be payable in US funds!!!!
  275.  
  276.    Be sure to use the proper upper/lower case when filling in your name and
  277.    BBS name, as they MUST match the way you entered them in the configuration
  278.    file.             ^^^^
  279.  
  280.    Based upon information supplied on the registration form, I will pre-
  281.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  282.    up your registration number or you may include a self-addressed stamped 
  283.    envelope and I will send registration back by return mail.
  284.  
  285.  
  286.  
  287.                                  MISC
  288.                                  ____
  289.  
  290.    The latest version of ADOPT and other fine SUNRISE DOOR programs, HIROLL,
  291.    TRIPLE YAHTZEE, WHEEL of FORTUNE and STATES are always available for 
  292.    download from SUNRISE-80 BBS (404-256-9525 HST 19.2), on first call!
  293.  
  294.    Remember, should you have any problems, questions or suggestions, be sure
  295.    to drop me a message on either of the aforementioned BBS or via the DOORS
  296.    conference on PCRELAY (RIME).  NODE=Sunrise
  297.  
  298.  
  299.